Use extra requirements to build readthedocs #546
Conversation
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: inknos The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Fixes: containers#532 Signed-off-by: Nicola Sella <[email protected]>
inknos
force-pushed
the
fix-readthedocs-requirements
branch
from
8329365 to
e75a2d3
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR updates the ReadTheDocs build configuration to use pip for installation and include the docs extras, ensuring documentation dependencies are installed correctly.
- Switches to pip-based install method
- Sets project path for installation
- Adds
extra_requirements: docsfor documentation build
Comments suppressed due to low confidence (2)
.readthedocs.yaml:23
-
The list item for
requirements.txthas an extra dash and incorrect indentation. It should be a single top-level list entry underinstall, for example:python:
install:
- requirements: requirements.txt
install:
.readthedocs.yaml:24
-
The
method,path, andextra_requirementskeys need to be indented under their-list entry. For example:python:
install:
- requirements: requirements.txt
- method: pip
path: .
extra_requirements:
- docs
method: pip
|
/lgtm |
The reference for this change is here although I don't know why it broke in version 4.9.0
Fixes: #532
cc: @jwhonce @Edward5hen